XXXXmmmmLLLLaaaabbbbeeeellll - The Label widget class
SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
#include <Xm/Label.h>
VVVVEEEERRRRSSSSIIIIOOOONNNN
This page documents Motif 2.1.
DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
Label is an instantiable widget and is also used as a
superclass for other button widgets, such as PushButton and
ToggleButton. The Label widget does not accept any button or
key input, and the help callback is the only callback
defined. Label also receives enter and leave events.
Label can contain either text or a pixmap. Label text is a
compound string. Refer to the _M_o_t_i_f _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_efor
more information on compound strings. The text can be
multilingual, multiline, and/or multifont. When a Label is
insensitive, its text is stippled, or the user-supplied
insensitive pixmap is displayed.
Label supports both accelerators and mnemonics primarily for
use in Label subclass widgets that are contained in menus.
Mnemonics are available in a menu system when the button is
visible. Accelerators in a menu system are accessible even
when the button is not visible. The Label widget displays
the mnemonic by underlining the first matching character in
the text string. The accelerator is displayed as a text
string adjacent to the label text or pixmap, depending on
the layout direction.
Label consists of many margin fields surrounding the text or
pixmap. These margin fields are resources that may be set
by the user, but Label subclasses and Manager parents also
modify some of these fields. They tend to modify the
XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnLLLLeeeefffftttt, XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnRRRRiiiigggghhhhtttt, XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnTTTToooopppp, and
XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnBBBBoooottttttttoooommmm resources and leave the XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnWWWWiiiiddddtttthhhh and
XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnHHHHeeeeiiiigggghhhhtttt resources as set by the application.
Label takes into account XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss in determining
its layout but does not draw the shadow. That is, if
XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssssis greater than 0 (zero), Label leaves
space for the shadow, but the shadow does not appear.
In a Label, XXXXmmmmNNNNttttrrrraaaavvvveeeerrrrssssaaaallllOOOOnnnn and XXXXmmmmNNNNhhhhiiiigggghhhhlllliiiigggghhhhttttOOOOnnnnEEEEnnnntttteeeerrrr are
forced to False inside Popup menu panes, Pulldown menu
panes, and OptionMenus. Otherwise, these resources default
Label and it subclasses, except when used in a menu system,
support dragging of the label contents from the Label.
However, the label contents are draggable only if the
XXXXmmmmNNNNeeeennnnaaaabbbblllleeeeUUUUnnnnsssseeeelllleeeeccccttttaaaabbbblllleeeeDDDDrrrraaaagggg resource of XXXXmmmmDDDDiiiissssppppllllaaaayyyyis set to
True.
As a source of data, Label and its subclasses support the
following targets and associated conversions of data to
these targets:
_l_o_c_a_l_e If the _l_o_c_a_l_e target matches the widget's locale,
the widget transfers XXXXmmmmNNNNllllaaaabbbbeeeellllSSSSttttrrrriiiinnnngggg in the
encoding of the locale. This target is supported
only when XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmSSSSTTTTRRRRIIIINNNNGGGG.
_C_O_M_P_O_U_N_D__T_E_X_T
The widget transfers XXXXmmmmNNNNllllaaaabbbbeeeellllSSSSttttrrrriiiinnnngggg as type
_C_O_M_P_O_U_N_D__T_E_X_T. This target is supported only when
XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmSSSSTTTTRRRRIIIINNNNGGGG.
_P_I_X_M_A_P The widget transfers XXXXmmmmNNNNllllaaaabbbbeeeellllPPPPiiiixxxxmmmmaaaapppp as type
_D_R_A_W_A_B_L_E. This target is supported only when
XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP.
_S_T_R_I_N_G The widget transfers XXXXmmmmNNNNllllaaaabbbbeeeellllSSSSttttrrrriiiinnnngggg as type
_S_T_R_I_N_G. This target is supported only when
XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmSSSSTTTTRRRRIIIINNNNGGGG.
_T_E_X_T If XXXXmmmmNNNNllllaaaabbbbeeeellllSSSSttttrrrriiiinnnngggg is fully convertible to the
encoding of the locale, the widget transfers
XXXXmmmmNNNNllllaaaabbbbeeeellllSSSSttttrrrriiiinnnngggg in the encoding of the locale.
Otherwise, the widget transfers XXXXmmmmNNNNllllaaaabbbbeeeellllSSSSttttrrrriiiinnnngggg as
type _C_O_M_P_O_U_N_D__T_E_X_T. This target is supported only
when XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmSSSSTTTTRRRRIIIINNNNGGGG.
when XXXXmmmmNNNNllllaaaayyyyoooouuuuttttDDDDiiiirrrreeeeccccttttiiiioooonnnn is XXXXmmmmLLLLEEEEFFFFTTTT____TTTTOOOO____RRRRIIIIGGGGHHHHTTTT. When
that resource is XXXXmmmmRRRRIIIIGGGGHHHHTTTT____TTTTOOOO____LLLLEEEEFFFFTTTT, the descriptions
for XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____BBBBEEEEGGGGIIIINNNNNNNNIIIINNNNGGGG and XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____EEEENNNNDDDD are
switched.
If the parent is a RowColumn whose XXXXmmmmNNNNiiiissssAAAAlllliiiiggggnnnneeeedddd
resource is True, XXXXmmmmNNNNaaaalllliiiiggggnnnnmmmmeeeennnntttt is forced to the
same value as the RowColumn's XXXXmmmmNNNNeeeennnnttttrrrryyyyAAAAlllliiiiggggnnnnmmmmeeeennnntttt if
the RowColumn's XXXXmmmmNNNNrrrroooowwwwCCCCoooolllluuuummmmnnnnTTTTyyyyppppeeee is XXXXmmmmWWWWOOOORRRRKKKK____AAAARRRREEEEAAAA or
if the widget is a subclass of XmLabel.
Otherwise, the default is XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____CCCCEEEENNNNTTTTEEEERRRR.
XXXXmmmmNNNNffffoooonnnnttttLLLLiiiisssstttt
Specifies the font of the text used in the widget.
XXXXmmmmNNNNffffoooonnnnttttLLLLiiiissssttttis obsolete and exists for
compatibility with previous releases. You should
now use XXXXmmmmNNNNrrrreeeennnnddddeeeerrrrTTTTaaaabbbblllleeee instead of XXXXmmmmNNNNffffoooonnnnttttLLLLiiiisssstttt. If
both are specified, the render table will take
precedence. If XXXXmmmmNNNNffffoooonnnnttttLLLLiiiisssstttt is NULL at
initialization, Label searches its parent
hierarchy for an ancestor that is a subclass of
the XmBulletinBoard, VendorShell, or XmMenuShell
widget class. If such an ancestor is found, Label
initializes XXXXmmmmNNNNffffoooonnnnttttLLLLiiiisssstttt to the XXXXmmmmNNNNllllaaaabbbbeeeellllFFFFoooonnnnttttLLLLiiiisssstttt of
the ancestor widget. Similarly, button subclasses
of Label initialize XXXXmmmmNNNNffffoooonnnnttttLLLLiiiisssstttt to the
XXXXmmmmNNNNbbbbuuuuttttttttoooonnnnFFFFoooonnnnttttLLLLiiiisssstttt of the ancestor widget.
(Currently, all subclasses of Label are button
subclasses.) If no such ancestor is found, the
default is implementation dependent. Refer to
XXXXmmmmFFFFoooonnnnttttLLLLiiiisssstttt(3) for more information on the creation
llllaaaabbbbeeeellllSSSSttttrrrriiiinnnngggg. If this value is NULL at
initialization, Label searches its parent
hierarchy for an ancestor that holds the
_X_m_Q_T_s_p_e_c_i_f_y_R_e_n_d_e_r_T_a_b_l_e trait. If such an ancestor
is found, Label initializes XXXXmmmmNNNNrrrreeeennnnddddeeeerrrrTTTTaaaabbbblllleeee to the
XXXXmmmmLLLLAAAABBBBEEEELLLL____RRRREEEENNNNDDDDEEEERRRR____TTTTAAAABBBBLLLLEEEE value of the ancestor widget.
Similarly, button subclasses of Label initialize
XXXXmmmmNNNNrrrreeeennnnddddeeeerrrrTTTTaaaabbbblllleeee to the XXXXmmmmBBBBUUUUTTTTTTTTOOOONNNN____RRRREEEENNNNDDDDEEEERRRR____TTTTAAAABBBBLLLLEEEE value
of the ancestor widget. (Note that all current
subclasses of Label are button subclasses.) If no
such ancestor is found, the default is
implementation dependent. If a font list and a
render table are both sepcified, the render table
will take precedence. Refer to XXXXmmmmRRRReeeennnnddddeeeerrrrTTTTaaaabbbblllleeee(3)
for more information on the creation and structure